/*
 * This file is part of the Sx Framework Library.
 * 
 * Copyright (C) 2013 University of Colorado Denver
 * <min.choi@ucdenver.edu> <shane.transue@ucdenver.edu>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */
#ifndef SX_PHYSICS_REPRESENTATION_H
#define SX_PHYSICS_REPRESENTATION_H

#include <sxGeometricRepresentation.h>

using Sx::Graphics::AbstractGeometricRepresentation;

namespace Sx {
namespace Physics {

/*
 * It is assumed that time is discretized during update events. This is
 * represented by Leibniz's Notation of an infinitesimal increment of time
 * defined as dt. The time interval dt may be defined by the application.
 */
template <typename PhysicalStateType>
class PhysicalRepresentation : public AbstractGeometricRepresentation<float> {
public:
	/*
	 * A physical representation may need to perform some additional operations
	 * during a construction phase. This function allows for internal 
	 * representations and data structures to be initialized for update
	 * operations.
	 */
	virtual bool construct() = 0;

	/*
	 * Physics Update
	 * 
	 * This interface function should update the internal state of the physical
	 * representation during the provided timestep.
	 */
	virtual void update(double dt) = 0;

	/* Graphics Update */
	void update(float dt);

	void setStatic(bool stationary);
	void setStationary(bool stationary);
	bool isStatic() const;
	bool isStationary() const;

	/* Public access to the state due to performance. */
	PhysicalStateType state;

protected:
	bool stationary;
};

template <typename PhysicalStateType>
void PhysicalRepresentation<PhysicalStateType>::update(float dt) { return; }

template <typename PhysicalStateType>
void PhysicalRepresentation<PhysicalStateType>::setStatic(bool stationary) {
	this->stationary = stationary;
}

template <typename PhysicalStateType>
void PhysicalRepresentation<PhysicalStateType>::setStationary(bool stationary) {
	this->stationary = stationary;
}

template <typename PhysicalStateType>
bool PhysicalRepresentation<PhysicalStateType>::isStatic() const {
	return this->stationary;
}

template <typename PhysicalStateType>
bool PhysicalRepresentation<PhysicalStateType>::isStationary() const {
	return this->stationary;
}

}

}

#endif
